@types/amqplib

What is @types/amqplib?

@types/amqplib provides TypeScript definitions for the amqplib library, which is a client for RabbitMQ, a popular message broker. This package allows TypeScript developers to use amqplib with type safety, ensuring that the code adheres to the expected types and interfaces.

What are @types/amqplib's main functionalities?

Connecting to RabbitMQ

This feature demonstrates how to establish a connection to a RabbitMQ server using amqplib. The code connects to a RabbitMQ server running on localhost and then closes the connection.

const amqp = require('amqplib');

async function connect() {
  try {
    const connection = await amqp.connect('amqp://localhost');
    console.log('Connected to RabbitMQ');
    await connection.close();
  } catch (error) {
    console.error('Failed to connect to RabbitMQ', error);
  }
}

connect();

Creating a Channel

This feature demonstrates how to create a channel after establishing a connection to RabbitMQ. Channels are used to perform most of the operations in RabbitMQ.

const amqp = require('amqplib');

async function createChannel() {
  try {
    const connection = await amqp.connect('amqp://localhost');
    const channel = await connection.createChannel();
    console.log('Channel created');
    await channel.close();
    await connection.close();
  } catch (error) {
    console.error('Failed to create channel', error);
  }
}

createChannel();

Sending a Message

This feature demonstrates how to send a message to a queue in RabbitMQ. The code creates a connection and a channel, asserts a queue, and sends a message to that queue.

const amqp = require('amqplib');

async function sendMessage() {
  try {
    const connection = await amqp.connect('amqp://localhost');
    const channel = await connection.createChannel();
    const queue = 'test_queue';
    const message = 'Hello, RabbitMQ!';

    await channel.assertQueue(queue);
    channel.sendToQueue(queue, Buffer.from(message));
    console.log(`Message sent: ${message}`);

    await channel.close();
    await connection.close();
  } catch (error) {
    console.error('Failed to send message', error);
  }
}

sendMessage();

Receiving a Message

This feature demonstrates how to receive messages from a queue in RabbitMQ. The code creates a connection and a channel, asserts a queue, and consumes messages from that queue.

const amqp = require('amqplib');

async function receiveMessage() {
  try {
    const connection = await amqp.connect('amqp://localhost');
    const channel = await connection.createChannel();
    const queue = 'test_queue';

    await channel.assertQueue(queue);
    console.log(`Waiting for messages in ${queue}`);

    channel.consume(queue, (msg) => {
      if (msg !== null) {
        console.log(`Received message: ${msg.content.toString()}`);
        channel.ack(msg);
      }
    });
  } catch (error) {
    console.error('Failed to receive message', error);
  }
}

receiveMessage();

Other packages similar to @types/amqplib

rhea

Rhea is a high-level AMQP 1.0 client for Node.js. It provides a more modern and flexible API compared to amqplib, which is based on AMQP 0.9.1. Rhea supports advanced features like message routing and filtering.

amqp-connection-manager

amqp-connection-manager is a wrapper around amqplib that provides automatic reconnection and connection pooling. It simplifies the management of RabbitMQ connections and channels, making it easier to build robust applications.

rascal

Rascal is a configuration-driven library for working with RabbitMQ. It builds on top of amqplib and provides features like message retry, dead-letter exchanges, and more. Rascal is designed to simplify the setup and management of RabbitMQ resources.

README

Installation

npm install --save @types/amqplib

Summary

This package contains type definitions for amqplib (https://github.com/squaremo/amqp.node).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/amqplib.

Additional Details

• Last updated: Sat, 21 Aug 2021 01:31:21 GMT
• Dependencies: @types/bluebird, @types/node
• Global values: none

Credits

These definitions were written by Michael Nahkies, Ab Reitsma, Nicolás Fantone, Nick Zelei, Vincenzo Chianese, and Seonggwon Yoon.